home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 626-637 / disk_635 / bootpic / bootpic.doc < prev    next >
Text File  |  1992-05-06  |  14KB  |  311 lines
  1. *******************************************************************************
  2. *                                                                             *
  3. *                                 BootPicV2.0                                 *
  4. *                                                                             *
  5. *                         © 1991,92 by Andreas Ackermann                      *
  6. *                                                                             *
  7. *******************************************************************************
  8.  
  9. CONTENTS:______________________________________________________________________
  10.  
  11.  
  12.        1. About shareware
  13.        2. Introduction
  14.        3. Installation of a picture
  15.        4. About the Parser
  16.        5. Kompatibility
  17.        6. What happens after resetting the machine ?
  18.        7. Possible sources of errors
  19.        8. History
  20.        9. About the programming
  21.  
  22. _______________________________________________________________________________
  23.  
  24. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  25. SHAREWARE-CONDITIONS:
  26.  
  27.     BootPic is SHAREWARE. You are allowed to copy BootPic as long as the
  28.     following conditions are kept :
  29.  
  30.     o  BootPic mustn't be changed
  31.     o  This DOC-file must be included
  32.     o  It mustn't be charged any fee (besides fees for copying or disks etc.)
  33.  
  34.     If you like BootPic and if you use it regularly or if you include parts of
  35.     the source in your own programms (e.g. the fading-routines) please send me
  36.     a small donation of 5$ or 5DM.
  37.  
  38.     If you want to use BootPic as part of a commercial programme, you need my
  39.     written permission.
  40.  
  41.     My Address:            Andreas Ackermann
  42.                            Lorenz-Summa-Str.10
  43.                            W-8679 Oberkotzau
  44.                            GERMANY
  45.                            Tel.:09286/6399
  46.  
  47. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  48.  
  49.                                INTRODUCTION
  50.  
  51. Do you belong to the group of people who think the «Workbench-hand» that
  52. appears after every reset to be boring ?
  53. Then BootPic is the right thing for you. It allows you to load (nearly) any
  54. IFF-ILBM-picture instead of the «hand». (Overscan, HAM, Halfbright, etc.) It
  55. just has to be in compressed form. (e.g. DPaint saves its pictures in com-
  56. pressed form ).
  57. The installed programme uses 1K more memory than the length of the picture-
  58. file. [ starting with V1.2 I use CHIP-Mem to avoid complications ! ]
  59. Starting with V2.0 it's also possible to load a MED-Module that is played while
  60. the picture is shown. MED is a Music-programm comparable to SoundTracker. The
  61. V3.00 of this programm is to be found on Fish 476. Please note: When you save
  62. your Music make sure that you selected 'MED-Module' as output format. That's
  63. the only one that can be handled by BootPic. (MED also loads SoundTracker-
  64. Modules and then you may save them in the MED-Module format !!!)
  65. ( A Demo-Module is provided in this drawer. )
  66. As these modules usually are quite large, you may also load modules crunched
  67. with the PowerPackerV2.3b ( Fish 253 ). Note: Crunched Modules may need up to
  68. 10s to decrunch at each reset !
  69.  
  70.                                INSTALLATION
  71.  
  72. BootPic can be started either from Workbench or CLI.
  73. If started from WB an intuition-style window with three gadgets will open :
  74.  
  75.  Load Pic&Music : If you click on this gadget a window with a stringgadget will
  76.                 open and asks you to enter a filename. If you press RETURN,
  77.                 BootPic will try to load this Picture, clicking on Cancel
  78.                 will stop any action. If you've got the ARP-Library installed,
  79.                 you'll get the ARP-Filerequester.
  80.                 If you selected BootPic together with another icon (see at
  81.                 example) you'll find its name already written in the string-
  82.                 gadget when opening the filerequester.
  83.                 After that you're asked whether you want to install a MED-
  84.                 Module or not.
  85.                 If you wanted to, the Requester (or the Stringgadget) will
  86.                 prompt you for another filename.
  87.                 After inputting a path, BootPic will try to load the picture.
  88.                 If an error occurs, nothing will be installed; if there's an
  89.                 error while loading the MED-Module only the picture will be
  90.                 installed.
  91.                 It's impossible to install a MED-Module without installing a
  92.                 picture.
  93.                 When loading a crunched module BootPic is unable to check
  94.                 whether it is a module or not !
  95.  Remove Picture :
  96.                 Does nothing but that.
  97.  Check all Drives :
  98.                 If this gadget is active when loading a picture, BootPic will
  99.                 check any connected drive for a bootable disk while displaying
  100.                 the picture. FFS-formatted disks also will be recognized.
  101.                 This switch is useful with OS 2.0 which allows to boot from
  102.                 any drive.
  103.                 If it's inactive, only df0: is checked.
  104.                 IMPORTANT:
  105.                 The state of this gadget is significant BEFORE loading an pic-
  106.                 ture. Toggling it after loading doesn't have any effect on the
  107.                 picture.
  108.  Color-Cycling: If it's active, it enables Color-Cycling if the corresponding
  109.                 information is saved with the picture ( CRNG-chunk )
  110.  Info :         Displays an info-message.
  111.  
  112. The error-messages are exactly the same as described below.
  113.  
  114. The color used to fade to after displaying the picture is taken from the
  115. background color of the workbench screen at the moment it is being installed.
  116.  
  117. EXAMPLE:
  118. ­­­­­­­­   To install the picture that is included on this Disk, do the
  119.            following steps:
  120.            Open the BootPic-drawer. Click on the demo.pic icon. Then double-
  121.            click on the BootPic icon while holding the SHIFT-key.
  122.            Click on the Load Picture -gadget and press RETURN.
  123.            Select 'Yes' in the requester that pops up afterwards.
  124.            Enter 'DemoSong.mod' and press RETURN
  125.            After resetting and removing any disks in df0: you can watch the
  126.            picture and enjoy the sound.
  127.  
  128.  
  129.  
  130. When started from CLI, BootPic is controlled by commandline parameters as
  131. usual. If no parameters are specified, a window as described above will open.
  132. The syntax is as follows :
  133.  
  134.           BootPic -e | -l{IFF-File} [-m{MED-Module}][-s][-r][-c rgb][-k][-y]
  135.  
  136. -l{IFF-File}  Removes, if present, an old picture and then tries to install
  137.               a new one instead.
  138.  
  139.               Message if it had success:
  140.               «Picture successfully installed. Have Fun !»
  141.  
  142.               Possible faults:
  143.               «Couldn't open Picture-File»
  144.               «This is not an ILBM-Picturefile»
  145.               «Picture is not compressed»
  146.               «Warning:Couldn't find CAMG-Chunk»
  147.               CAMG-Chunk not found : The viewmodes are saved in this chunk
  148.               [e.g. Hires or Interlace etc.]. Until Kickstart 1.3 the picture
  149.               will be shown correctly despite of CAMG's missing.
  150.               [RESTRICTION: instead of Halfbright, HAM will be selected.]
  151.               «BODY-Chunk not found»
  152.               ILBM-File didn't contain image-data (should never happen).
  153.               «Memlist corrupt. Something went totally wrong»
  154.               Meaning see at -e
  155.               «Not enough Memory»
  156.               «Couldn't open Module / Not a MED-Module»
  157.               Error while loading the MED-Module:[either one of these]
  158.               - lack of memory
  159.               - file wasn't a module
  160.               - file not found
  161.               Nevertheless, the picture itself will be installed.
  162.  
  163. -e            Removes, if present, an old picture.
  164.  
  165.               Message if successful:
  166.               «Removed BootPic from List»
  167.  
  168.               Possible faults:
  169.               «BootPic not installed. Couldn't remove it»
  170.               «Memlist corrupt. Something went totally wrong»
  171.               BootPic discovered its memory, but it couldn't find its entry in
  172.               the resident table (should never happen).
  173.  
  174.               The following parameters work only together with -l :
  175.  
  176. -m{MED-Module}
  177.               loads additionally a MED-Module. If it can't be loaded, just the
  178.               picture will be installed.
  179. -s            loads the file specified by -l only if BootPic is not yet
  180.               installed. In this way it is possible to use BootPic in the
  181.               Startup-Sequence.
  182.  
  183.               If BootPic was already installed it prints out :
  184.               «BootPic already installed. Changed nothing.»
  185.  
  186. -r            BootPic resets the machine after loading the picture.
  187.  
  188. -c            here you can specify the color which should be faded in after
  189.               showing the picture. Normally this is the background color of
  190.               your Workbench-Screen. The values of r,g and b must be specified
  191.               hexadecimal, so values from 0-9 and a-f are valid. [0 means that
  192.               this component isn't there at all and f means that it is there at
  193.               maximum idensity. (e.g. -c000 for black, -ce50 for orange).
  194.               Invalid values are accepted but the result will be other than
  195.               expected.
  196.               Default: 05a [Amiga-blue]
  197. -k            enables checking of all drives [see above]
  198. -y            enables color-cycling [see above]
  199.  
  200.  
  201.                                 ABOUT the PARSER
  202.  
  203.  All parameters may be specified either as small or capital letters. Every
  204.  parameter MUST start with «-», the order is at pleasure. Between the single
  205.  parmeters any number of spaces may be typed .
  206.  
  207.  Valid calls would be :
  208.  
  209.   bootpic  -l  :BootPic/demo.pic -R   -c  7aB
  210.  
  211.   bootpic -E
  212.  
  213.   bootpic -cAE3  -S -l:bootpic/demo.pic
  214.  
  215.  If -e or -l aren't specified, or if something else was typed wrong, BootPic
  216.  shows the usage.
  217.  If -e AND -l are specified, BootPic acts as if just -e was specified.
  218.  
  219.                                  KOMPATIBILTY
  220.  
  221.  BootPic installs itself in a «kindly» way, that means that any other resident
  222.  programme won't  be removed, e.g. Guardian, CARD:, but also viruses.
  223.  In the same careful way it removes itself.
  224.  It should run on every Amiga with Kick 1.2 or 1.3. It also runs on the A500+
  225.  with OS 2.0, but I'm not sure about the A3000.
  226.  Restriction: Truble occurs on some A2000 with Kick 1.3 and 1MB Chipmem.
  227.  ( Seems to depend on the error which is patched by Setpatch -r ; as I haven't
  228.  acces to such an Amiga, I can't do anything about it.)
  229.  
  230.                    What happens after RESETTING the machine  ?
  231.  
  232.  When BootPic was successfully installed, the loaded picture will be faded in
  233.  softly whenever there's no bootable disk in df0: [or any other drive] .
  234.  If you additionally loaded a MED-Module, it will be played while the picture
  235.  is shown. Packed modules may need up to 10s to decrunch ! You may abort
  236.  decrunching by pressing the left mousebutton. In this case the picture will
  237.  disappear and the normal Workbenchhand appears.
  238.  If the uncrunched file actually isn't a Module you won't hear anything !
  239.  You may toggle the sound-filter with the right mousebutton ( the filter is
  240.  connected with the PowerLED so you actually toggle both ).
  241.  When inserting a bootable disk the colors will be faded softly to the color
  242.  specified under -c and your system starts as usual .
  243.  [The fading of HAM-pictures looks a little bit curious but that's NO bug.]
  244.  If you press the left mouse button while the picture is shown, the usual
  245.  workbench-hand appears.
  246.  
  247.                          Possbile SOURCES of ERRORS
  248.  
  249.  Normally a picture that was once installed, stays in memory until you remove
  250.  it with -e [Remove Picture] or till you switch off your Amiga.
  251.  But there are some exceptions:
  252.  
  253.   a.)  If you play a game that believes all the memory belongs to itsself, it
  254.        is possible that the memory allocated by BootPic is overwritten.
  255.        Then you won't see the picture any more.
  256.   b.)  Many viruses simply overwrite the reset-vectors. In this case BootPic
  257.        will be gone, too.
  258.   c.)  Some virusdedectors (e.g. ATool) are of the opinion that every resident
  259.        programme is a virus, so BootPic will be removed, too.
  260.  
  261.  If one of these cases should arise, it may be possible, that you get a GURU
  262.  after a reset. If you can't remove it by clicking the left mousebutton,
  263.  switching off the Amiga is the only thing you can do.
  264.  
  265.  
  266.  
  267.                                  HISTORY
  268.  
  269.  V1.0 - first release, only Cli-Support
  270.  V1.1 - intuition-interface
  271.  V1.2 - added 'Color-Cycling' and 'Check all Drives'
  272.       - Resident Code and Data MUST be placed in Chip-Mem [only exception:
  273.         internal expansions of 512k at location $C00000 (e.g. I've this one)].
  274.         Now it uses Chip-Mem. Sorry, I didn't know about this limitation.
  275.       - There was some code that caused BootPic to guru on the A500 Plus with
  276.         OS 2.0 after displaying the picture. Now it works ...
  277.       - Fixed one bug that caused serious errors when loading IFF-files with
  278.         more than 32 colors saved ( like the HAM-Demo-pics of DPaintIV ).
  279.       - Brushes now are handled correctly.
  280.  V2.0 - MED-Module support
  281.  
  282.                                PROGRAMMING
  283.  
  284.  BootPic was written with the Devpac 2.14D - Assembler.
  285.  Many thanks go to JM Forgeas for the wonderful editor AZ V1.50.
  286.  Thanks Markus Herpich who provided me his brandnew A500+ for a whole
  287.  afternoon.
  288.  
  289.  The code for playing the sound was written by Teijo Kinnunen.
  290.  I took it from the MEDV3.0 package distributed on Fish 476.
  291.  [Files: loadmod.i and modplayer.i]
  292.  The decrunching code is ©opyrighted by Nico François. I took it from Fish 253.
  293.  
  294.  Also greetings to the 10 ( really ten, not more [since june 1991] !) kind
  295.  people who sent me the demanded fee or bug reports. Hope there'll be more in
  296.  future ...
  297.  
  298.  Future Versions:
  299.  Less bugs (I don't know any more, but there surely are ... )
  300.  Improved fading; color-cycling while fading; improved code
  301.  But remember: future improvements depend on YOUR support !!!
  302.  
  303.  I am very thankful for critics, propositions and BUG-reports.
  304.  
  305.                          ENJOY !
  306.  
  307.   Oberkotzau, january 28th 1992               Andreas Ackermann [*10.07.1974]
  308.   [ excuse my mistakes !!! ]
  309.  
  310.  
  311.